Report Request

The ReportRequest API enables to fetch various types of report

Method: POST

{{URL}}/rtp/rpc/TransactionService/ReportRequest

Headers

Name	Value
Content-Type	application/json
Credential	"Basic c3VwcG9ydCsxQG5ldHN5cy1pbmMuY29tOjM5ZDYxOGJkNTVmN5NWQxY2RlNDE5"
Signature	"{{signature}}"

Example

Payload Parameters

Parameter	Description
accountProperty Conditional Mandatory	String Specific account type (Mandatory if report type is ABAR) Possible values: "M" - Master Account "S" – Sub Account Example – "M"
accountRoutingNumber Mandatory	String Routing number of the account for which the report is requested Example – "812812388"
connectionpartyId Mandatory	String Unique ID of the service provider that establishes a connection to the FedNow service Example – "111222"
fromDate Mandatory	String The beginning date from where the report to be generated Example – "2024-04-29"
processor Optional	String Payment channel through which the transaction happens Example – "FEDNOW"
referenceNumber Mandatory	String Reference number of the report request message Example – "REPORTREQ100011762784818"
reportType Mandatory	String Type of report Possible values: "AATR" "IATR" "AADR" "ABAR" Example – "AADR"
routingNumber Mandatory	String Routing number of the bank where the report is generated Example – "011001331"
toDate Mandatory	String The end date till which the report to be generated Example – "2024-04-29"

cURL

curl --location --globoff '{{URL}}/rtp/rpc/TransactionService/ReportRequest' \
--header 'Content-Type: application/json' \
--data '{"accountProperty":"M","accountRoutingNumber":"812812388","connectionpartyId":"111222","fromDate":"2024-04-29","processor":"FEDNOW","referenceNumber":"REPORTREQ100011762784818","reportType":"AADR","routingNumber":"011001331","toDate":"2024-04-29"}'

C#

var options = new RestClientOptions("{{URL}}/rtp/rpc/TransactionService/ReportRequest")
{
  MaxTimeout = -1,
};
var client = new RestClient(options);
var request = new RestRequest("", Method.Post);
request.AddHeader("Content-Type", "application/json");
var body = @"{
" + "\n" +
@"  ""accountProperty"": ""M"",
" + "\n" +
@"  ""accountRoutingNumber"": ""812812388"",
" + "\n" +
@"  ""connectionpartyId"": ""111222"",
" + "\n" +
@"  ""fromDate"": ""2024-04-29"",
" + "\n" +
@"  ""processor"": ""FEDNOW"",
" + "\n" +
@"  ""referenceNumber"": ""REPORTREQ100011762784818"",
" + "\n" +
@"  ""reportType"": ""AADR"",
" + "\n" +
@"  ""routingNumber"": ""011001331"",
" + "\n" +
@"  ""toDate"": ""2024-04-29""
" + "\n" +
@"}";
request.AddStringBody(body, DataFormat.Json);
RestResponse response = await client.ExecuteAsync(request);
Console.WriteLine(response.Content);

Go

package main

import (
  "fmt"
  "strings"
  "net/http"
  "io/ioutil"
)

func main() {

  url := "{{URL}}/rtp/rpc/TransactionService/ReportRequest"
  method := "POST"

  payload := strings.NewReader(`{`+"
"+`
  "accountProperty": "M",`+"
"+`
  "accountRoutingNumber": "812812388",`+"
"+`
  "connectionpartyId": "111222",`+"
"+`
  "fromDate": "2024-04-29",`+"
"+`
  "processor": "FEDNOW",`+"
"+`
  "referenceNumber": "REPORTREQ100011762784818",`+"
"+`
  "reportType": "AADR",`+"
"+`
  "routingNumber": "011001331",`+"
"+`
  "toDate": "2024-04-29"`+"
"+`
}`)

  client := &http.Client {
  }
  req, err := http.NewRequest(method, url, payload)

  if err != nil {
    fmt.Println(err)
    return
  }
  req.Header.Add("Content-Type", "application/json")

  res, err := client.Do(req)
  if err != nil {
    fmt.Println(err)
    return
  }
  defer res.Body.Close()

  body, err := ioutil.ReadAll(res.Body)
  if err != nil {
    fmt.Println(err)
    return
  }
  fmt.Println(string(body))
}

NodeJs

var https = require('follow-redirects').https;
var fs = require('fs');

var options = {
  'method': 'POST',
  'hostname': '{{URL}}',
  'path': '/rtp/rpc/TransactionService/ReportRequest',
  'headers': {
    'Content-Type': 'application/json'
  },
  'maxRedirects': 20
};

var req = https.request(options, function (res) {
  var chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function (chunk) {
    var body = Buffer.concat(chunks);
    console.log(body.toString());
  });

  res.on("error", function (error) {
    console.error(error);
  });
});

var postData = JSON.stringify({
  "accountProperty": "M",
  "accountRoutingNumber": "812812388",
  "connectionpartyId": "111222",
  "fromDate": "2024-04-29",
  "processor": "FEDNOW",
  "referenceNumber": "REPORTREQ100011762784818",
  "reportType": "AADR",
  "routingNumber": "011001331",
  "toDate": "2024-04-29"
});

req.write(postData);

req.end();

Request Body (Applicable only for FedNow)

{
  "accountProperty": "M",
  "accountRoutingNumber": "812812388",
  "connectionpartyId": "111222",
  "fromDate": "2024-04-29",
  "processor": "FEDNOW",
  "referenceNumber": "REPORTREQ100011762784818",
  "reportType": "AADR",
  "routingNumber": "011001331",
  "toDate": "2024-04-29"
}

Response: 200

Response Parameters

Parameter	Description
message	String Response message for the report Example – "success"
rawMessage	String Base64 Value of Received Response Example – "Base64 Value of Received Response"
status	String Status of the request Example – "Accepted"

Response Body (Applicable only for FedNow)

{
  "message": "success",
  "rawMessage": "Base64 Value of Received Response",
  "status": "SUCCESS"
}